<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    <a name="line.1"></a>
<FONT color="green">002</FONT>    /*<a name="line.2"></a>
<FONT color="green">003</FONT>     * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * $Id: SchemaUpdater.html 34 2011-02-18 15:25:41Z archie.cobbs $<a name="line.5"></a>
<FONT color="green">006</FONT>     */<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    package org.dellroad.stuff.schema;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import java.sql.Connection;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.sql.PreparedStatement;<a name="line.11"></a>
<FONT color="green">012</FONT>    import java.sql.ResultSet;<a name="line.12"></a>
<FONT color="green">013</FONT>    import java.sql.SQLException;<a name="line.13"></a>
<FONT color="green">014</FONT>    import java.sql.Statement;<a name="line.14"></a>
<FONT color="green">015</FONT>    import java.util.ArrayList;<a name="line.15"></a>
<FONT color="green">016</FONT>    import java.util.Collection;<a name="line.16"></a>
<FONT color="green">017</FONT>    import java.util.Comparator;<a name="line.17"></a>
<FONT color="green">018</FONT>    import java.util.Date;<a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.HashMap;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.HashSet;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.List;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Set;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import javax.sql.DataSource;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import org.dellroad.stuff.graph.TopologicalSorter;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.slf4j.Logger;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.slf4j.LoggerFactory;<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>    /**<a name="line.30"></a>
<FONT color="green">031</FONT>     * Database schema updater that manages initializing and updates to a database schema.<a name="line.31"></a>
<FONT color="green">032</FONT>     *<a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;p&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     * The primary method is {@link #initializeAndUpdateDatabase initializeAndUpdateDatabase()}, which will:<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;ul&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;li&gt; Automatically initialize an empty database when necessary;&lt;/li&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;li&gt; Automatically apply configured {@link SchemaUpdate}s as needed, ordered properly according to<a name="line.37"></a>
<FONT color="green">038</FONT>     *      their predecessor constraints; and&lt;/li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;li&gt; Automatically keep track of which {@link SchemaUpdate}s have already been applied across restarts.&lt;/li&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;/ul&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;/p&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     *<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;p&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     * Required properties are the {@link #setDatabaseInitialization database initialization},<a name="line.44"></a>
<FONT color="green">045</FONT>     * {@link #setUpdateTableInitialization update table initialization}, and the {@link #setUpdates updates} themselves.<a name="line.45"></a>
<FONT color="green">046</FONT>     * &lt;/p&gt;<a name="line.46"></a>
<FONT color="green">047</FONT>     *<a name="line.47"></a>
<FONT color="green">048</FONT>     * &lt;p&gt;<a name="line.48"></a>
<FONT color="green">049</FONT>     * Applied updates are recorded in a special &lt;i&gt;update table&lt;/i&gt;, which contains two columns: one for the unique<a name="line.49"></a>
<FONT color="green">050</FONT>     * {@link SchemaUpdate#getName update name} and one for a timestamp. The update table and column names<a name="line.50"></a>
<FONT color="green">051</FONT>     * are configurable via {@link #setUpdateTableName setUpdateTableName()},<a name="line.51"></a>
<FONT color="green">052</FONT>     * {@link #setUpdateTableNameColumn setUpdateTableNameColumn()}, and {@link #setUpdateTableTimeColumn setUpdateTableTimeColumn()}.<a name="line.52"></a>
<FONT color="green">053</FONT>     * &lt;/p&gt;<a name="line.53"></a>
<FONT color="green">054</FONT>     *<a name="line.54"></a>
<FONT color="green">055</FONT>     * &lt;p&gt;<a name="line.55"></a>
<FONT color="green">056</FONT>     * By default, this class detects a completely uninitialized database by the absence of the update table itself<a name="line.56"></a>
<FONT color="green">057</FONT>     * in the schema (see {@link #databaseNeedsInitialization databaseNeedsInitialization()}).<a name="line.57"></a>
<FONT color="green">058</FONT>     * When an uninitialized database is encountered, the configured {@link #setDatabaseInitialization database initialization}<a name="line.58"></a>
<FONT color="green">059</FONT>     * and {@link #setUpdateTableInitialization update table initialization} actions are applied first to initialize<a name="line.59"></a>
<FONT color="green">060</FONT>     * the database schema.<a name="line.60"></a>
<FONT color="green">061</FONT>     * &lt;/p&gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     */<a name="line.62"></a>
<FONT color="green">063</FONT>    public class SchemaUpdater {<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>        /**<a name="line.65"></a>
<FONT color="green">066</FONT>         * Default nefault name of the table that tracks schema updates, &lt;code&gt;{@value}&lt;/code&gt;.<a name="line.66"></a>
<FONT color="green">067</FONT>         */<a name="line.67"></a>
<FONT color="green">068</FONT>        public static final String DEFAULT_UPDATE_TABLE_NAME = "SchemaUpdate";<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>        /**<a name="line.70"></a>
<FONT color="green">071</FONT>         * Default name of the column in the updates table holding the unique update name, &lt;code&gt;{@value}&lt;/code&gt;.<a name="line.71"></a>
<FONT color="green">072</FONT>         */<a name="line.72"></a>
<FONT color="green">073</FONT>        public static final String DEFAULT_UPDATE_TABLE_NAME_COLUMN = "updateName";<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>        /**<a name="line.75"></a>
<FONT color="green">076</FONT>         * Default name of the column in the updates table holding the update's time applied, &lt;code&gt;{@value}&lt;/code&gt;.<a name="line.76"></a>
<FONT color="green">077</FONT>         */<a name="line.77"></a>
<FONT color="green">078</FONT>        public static final String DEFAULT_UPDATE_TABLE_TIME_COLUMN = "updateTime";<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>        protected final Logger log = LoggerFactory.getLogger(getClass());<a name="line.80"></a>
<FONT color="green">081</FONT>    <a name="line.81"></a>
<FONT color="green">082</FONT>        private String updateTableName = DEFAULT_UPDATE_TABLE_NAME;<a name="line.82"></a>
<FONT color="green">083</FONT>        private String updateTableNameColumn = DEFAULT_UPDATE_TABLE_NAME_COLUMN;<a name="line.83"></a>
<FONT color="green">084</FONT>        private String updateTableTimeColumn = DEFAULT_UPDATE_TABLE_TIME_COLUMN;<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>        private Collection&lt;SchemaUpdate&gt; updates;<a name="line.86"></a>
<FONT color="green">087</FONT>        private DatabaseAction databaseInitialization;<a name="line.87"></a>
<FONT color="green">088</FONT>        private DatabaseAction updateTableInitialization;<a name="line.88"></a>
<FONT color="green">089</FONT>        private boolean ignoreUnrecognizedUpdates;<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>        /**<a name="line.91"></a>
<FONT color="green">092</FONT>         * Get the name of the table that keeps track of applied updates.<a name="line.92"></a>
<FONT color="green">093</FONT>         *<a name="line.93"></a>
<FONT color="green">094</FONT>         * @see #setUpdateTableName setUpdateTableName()<a name="line.94"></a>
<FONT color="green">095</FONT>         */<a name="line.95"></a>
<FONT color="green">096</FONT>        public String getUpdateTableName() {<a name="line.96"></a>
<FONT color="green">097</FONT>            return this.updateTableName;<a name="line.97"></a>
<FONT color="green">098</FONT>        }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>        /**<a name="line.100"></a>
<FONT color="green">101</FONT>         * Set the name of the table that keeps track of applied updates.<a name="line.101"></a>
<FONT color="green">102</FONT>         * Default value is {@link #DEFAULT_UPDATE_TABLE_NAME}.<a name="line.102"></a>
<FONT color="green">103</FONT>         *<a name="line.103"></a>
<FONT color="green">104</FONT>         * &lt;p&gt;<a name="line.104"></a>
<FONT color="green">105</FONT>         * This name must be consistent with the {@link #setUpdateTableInitialization update table initialization}.<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        public void setUpdateTableName(String updateTableName) {<a name="line.107"></a>
<FONT color="green">108</FONT>            this.updateTableName = updateTableName;<a name="line.108"></a>
<FONT color="green">109</FONT>        }<a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>        /**<a name="line.111"></a>
<FONT color="green">112</FONT>         * Get the name of the update name column in the table that keeps track of applied updates.<a name="line.112"></a>
<FONT color="green">113</FONT>         *<a name="line.113"></a>
<FONT color="green">114</FONT>         * @see #setUpdateTableNameColumn setUpdateTableNameColumn()<a name="line.114"></a>
<FONT color="green">115</FONT>         */<a name="line.115"></a>
<FONT color="green">116</FONT>        public String getUpdateTableNameColumn() {<a name="line.116"></a>
<FONT color="green">117</FONT>            return this.updateTableNameColumn;<a name="line.117"></a>
<FONT color="green">118</FONT>        }<a name="line.118"></a>
<FONT color="green">119</FONT>    <a name="line.119"></a>
<FONT color="green">120</FONT>        /**<a name="line.120"></a>
<FONT color="green">121</FONT>         * Set the name of the update name column in the table that keeps track of applied updates.<a name="line.121"></a>
<FONT color="green">122</FONT>         * Default value is {@link #DEFAULT_UPDATE_TABLE_NAME_COLUMN}.<a name="line.122"></a>
<FONT color="green">123</FONT>         *<a name="line.123"></a>
<FONT color="green">124</FONT>         * &lt;p&gt;<a name="line.124"></a>
<FONT color="green">125</FONT>         * This name must be consistent with the {@link #setUpdateTableInitialization update table initialization}.<a name="line.125"></a>
<FONT color="green">126</FONT>         */<a name="line.126"></a>
<FONT color="green">127</FONT>        public void setUpdateTableNameColumn(String updateTableNameColumn) {<a name="line.127"></a>
<FONT color="green">128</FONT>            this.updateTableNameColumn = updateTableNameColumn;<a name="line.128"></a>
<FONT color="green">129</FONT>        }<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>        /**<a name="line.131"></a>
<FONT color="green">132</FONT>         * Get the name of the update timestamp column in the table that keeps track of applied updates.<a name="line.132"></a>
<FONT color="green">133</FONT>         *<a name="line.133"></a>
<FONT color="green">134</FONT>         * @see #setUpdateTableTimeColumn setUpdateTableTimeColumn()<a name="line.134"></a>
<FONT color="green">135</FONT>         */<a name="line.135"></a>
<FONT color="green">136</FONT>        public String getUpdateTableTimeColumn() {<a name="line.136"></a>
<FONT color="green">137</FONT>            return this.updateTableTimeColumn;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>        /**<a name="line.140"></a>
<FONT color="green">141</FONT>         * Set the name of the update timestamp column in the table that keeps track of applied updates.<a name="line.141"></a>
<FONT color="green">142</FONT>         * Default value is {@link #DEFAULT_UPDATE_TABLE_TIME_COLUMN}.<a name="line.142"></a>
<FONT color="green">143</FONT>         *<a name="line.143"></a>
<FONT color="green">144</FONT>         * &lt;p&gt;<a name="line.144"></a>
<FONT color="green">145</FONT>         * This name must be consistent with the {@link #setUpdateTableInitialization update table initialization}.<a name="line.145"></a>
<FONT color="green">146</FONT>         */<a name="line.146"></a>
<FONT color="green">147</FONT>        public void setUpdateTableTimeColumn(String updateTableTimeColumn) {<a name="line.147"></a>
<FONT color="green">148</FONT>            this.updateTableTimeColumn = updateTableTimeColumn;<a name="line.148"></a>
<FONT color="green">149</FONT>        }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>        /**<a name="line.151"></a>
<FONT color="green">152</FONT>         * Get the update table initialization.<a name="line.152"></a>
<FONT color="green">153</FONT>         *<a name="line.153"></a>
<FONT color="green">154</FONT>         * @see #setUpdateTableInitialization setUpdateTableInitialization()<a name="line.154"></a>
<FONT color="green">155</FONT>         */<a name="line.155"></a>
<FONT color="green">156</FONT>        public DatabaseAction getUpdateTableInitialization() {<a name="line.156"></a>
<FONT color="green">157</FONT>            return this.updateTableInitialization;<a name="line.157"></a>
<FONT color="green">158</FONT>        }<a name="line.158"></a>
<FONT color="green">159</FONT>    <a name="line.159"></a>
<FONT color="green">160</FONT>        /**<a name="line.160"></a>
<FONT color="green">161</FONT>         * Configure how the update table itself gets initialized. This update is run when no update table found,<a name="line.161"></a>
<FONT color="green">162</FONT>         * which (we assume) implies an empty database with no tables or content. This is a required property.<a name="line.162"></a>
<FONT color="green">163</FONT>         *<a name="line.163"></a>
<FONT color="green">164</FONT>         * &lt;p&gt;<a name="line.164"></a>
<FONT color="green">165</FONT>         * This initialization should create the update table where the name column is the primary key.<a name="line.165"></a>
<FONT color="green">166</FONT>         * The name column must have a length limit greater than or equal to the longest schema update name.<a name="line.166"></a>
<FONT color="green">167</FONT>         *<a name="line.167"></a>
<FONT color="green">168</FONT>         * &lt;p&gt;<a name="line.168"></a>
<FONT color="green">169</FONT>         * The table and column names must be consistent with the values configured via<a name="line.169"></a>
<FONT color="green">170</FONT>         * {@link #setUpdateTableName setUpdateTableName()}, {@link #setUpdateTableNameColumn setUpdateTableNameColumn()},<a name="line.170"></a>
<FONT color="green">171</FONT>         * and {@link #setUpdateTableTimeColumn setUpdateTableTimeColumn()}.<a name="line.171"></a>
<FONT color="green">172</FONT>         *<a name="line.172"></a>
<FONT color="green">173</FONT>         * &lt;p&gt;<a name="line.173"></a>
<FONT color="green">174</FONT>         * For convenience, pre-defined initialization scripts using the default table and column names are available<a name="line.174"></a>
<FONT color="green">175</FONT>         * at the following resource locations. These can be used to configure a {@link SQLDatabaseAction}:<a name="line.175"></a>
<FONT color="green">176</FONT>         * &lt;table border="1" cellspacing="0" cellpadding="4"&gt;<a name="line.176"></a>
<FONT color="green">177</FONT>         * &lt;tr&gt;<a name="line.177"></a>
<FONT color="green">178</FONT>         * &lt;th&gt;Database&lt;/th&gt;<a name="line.178"></a>
<FONT color="green">179</FONT>         * &lt;th&gt;Resource&lt;/th&gt;<a name="line.179"></a>
<FONT color="green">180</FONT>         * &lt;/tr&gt;<a name="line.180"></a>
<FONT color="green">181</FONT>         * &lt;tr&gt;<a name="line.181"></a>
<FONT color="green">182</FONT>         * &lt;/tr&gt;<a name="line.182"></a>
<FONT color="green">183</FONT>         * &lt;td&gt;MySQL (InnoDB)&lt;/td&gt;<a name="line.183"></a>
<FONT color="green">184</FONT>         * &lt;td&gt;&lt;code&gt;classpath:org/dellroad/stuff/schema/updateTable-mysql.sql&lt;/code&gt;&lt;/td&gt;<a name="line.184"></a>
<FONT color="green">185</FONT>         * &lt;/tr&gt;<a name="line.185"></a>
<FONT color="green">186</FONT>         * &lt;/table&gt;<a name="line.186"></a>
<FONT color="green">187</FONT>         *<a name="line.187"></a>
<FONT color="green">188</FONT>         * @param updateTableInitialization update table schema initialization<a name="line.188"></a>
<FONT color="green">189</FONT>         * @see #setUpdateTableName setUpdateTableName()<a name="line.189"></a>
<FONT color="green">190</FONT>         * @see #setUpdateTableNameColumn setUpdateTableNameColumn()<a name="line.190"></a>
<FONT color="green">191</FONT>         * @see #setUpdateTableTimeColumn setUpdateTableTimeColumn()<a name="line.191"></a>
<FONT color="green">192</FONT>         */<a name="line.192"></a>
<FONT color="green">193</FONT>        public void setUpdateTableInitialization(DatabaseAction updateTableInitialization) {<a name="line.193"></a>
<FONT color="green">194</FONT>            this.updateTableInitialization = updateTableInitialization;<a name="line.194"></a>
<FONT color="green">195</FONT>        }<a name="line.195"></a>
<FONT color="green">196</FONT>    <a name="line.196"></a>
<FONT color="green">197</FONT>        /**<a name="line.197"></a>
<FONT color="green">198</FONT>         * Get the empty database initialization.<a name="line.198"></a>
<FONT color="green">199</FONT>         *<a name="line.199"></a>
<FONT color="green">200</FONT>         * @see #setDatabaseInitialization setDatabaseInitialization()<a name="line.200"></a>
<FONT color="green">201</FONT>         */<a name="line.201"></a>
<FONT color="green">202</FONT>        public DatabaseAction getDatabaseInitialization() {<a name="line.202"></a>
<FONT color="green">203</FONT>            return this.databaseInitialization;<a name="line.203"></a>
<FONT color="green">204</FONT>        }<a name="line.204"></a>
<FONT color="green">205</FONT>    <a name="line.205"></a>
<FONT color="green">206</FONT>        /**<a name="line.206"></a>
<FONT color="green">207</FONT>         * Configure how an empty database gets initialized. This is a required property.<a name="line.207"></a>
<FONT color="green">208</FONT>         *<a name="line.208"></a>
<FONT color="green">209</FONT>         * &lt;p&gt;<a name="line.209"></a>
<FONT color="green">210</FONT>         * This update is run when no update table found, which (we assume) implies an empty database with no tables or content.<a name="line.210"></a>
<FONT color="green">211</FONT>         * Typically this contains the SQL script that gets automatically generated by your favorite schema generation tool.<a name="line.211"></a>
<FONT color="green">212</FONT>         *<a name="line.212"></a>
<FONT color="green">213</FONT>         * &lt;p&gt;<a name="line.213"></a>
<FONT color="green">214</FONT>         * This script is expected to initialize the database schema (i.e., creating all the tables) so that<a name="line.214"></a>
<FONT color="green">215</FONT>         * when completed the database is "up to date" with respect to the configured schema updates.<a name="line.215"></a>
<FONT color="green">216</FONT>         * That is, when this action completes, we assume all updates have already been (implicitly) applied<a name="line.216"></a>
<FONT color="green">217</FONT>         * (and they will be recorded as such).<a name="line.217"></a>
<FONT color="green">218</FONT>         *<a name="line.218"></a>
<FONT color="green">219</FONT>         * &lt;p&gt;<a name="line.219"></a>
<FONT color="green">220</FONT>         * Note this script is &lt;i&gt;not&lt;/i&gt; expected to create the update table that tracks schema updates;<a name="line.220"></a>
<FONT color="green">221</FONT>         * that function is handled by the {@link #setUpdateTableInitialization update table initialization}.<a name="line.221"></a>
<FONT color="green">222</FONT>         *<a name="line.222"></a>
<FONT color="green">223</FONT>         * @param databaseInitialization application database schema initialization<a name="line.223"></a>
<FONT color="green">224</FONT>         */<a name="line.224"></a>
<FONT color="green">225</FONT>        public void setDatabaseInitialization(DatabaseAction databaseInitialization) {<a name="line.225"></a>
<FONT color="green">226</FONT>            this.databaseInitialization = databaseInitialization;<a name="line.226"></a>
<FONT color="green">227</FONT>        }<a name="line.227"></a>
<FONT color="green">228</FONT>    <a name="line.228"></a>
<FONT color="green">229</FONT>        /**<a name="line.229"></a>
<FONT color="green">230</FONT>         * Get the configured schema updates.<a name="line.230"></a>
<FONT color="green">231</FONT>         *<a name="line.231"></a>
<FONT color="green">232</FONT>         * @return configured schema updates<a name="line.232"></a>
<FONT color="green">233</FONT>         * @see #setUpdates setUpdates()<a name="line.233"></a>
<FONT color="green">234</FONT>         */<a name="line.234"></a>
<FONT color="green">235</FONT>        public Collection&lt;SchemaUpdate&gt; getUpdates() {<a name="line.235"></a>
<FONT color="green">236</FONT>            return this.updates;<a name="line.236"></a>
<FONT color="green">237</FONT>        }<a name="line.237"></a>
<FONT color="green">238</FONT>    <a name="line.238"></a>
<FONT color="green">239</FONT>        /**<a name="line.239"></a>
<FONT color="green">240</FONT>         * Configure the schema updates.<a name="line.240"></a>
<FONT color="green">241</FONT>         * This should be the set of all updates that may need to be applied to the database.<a name="line.241"></a>
<FONT color="green">242</FONT>         *<a name="line.242"></a>
<FONT color="green">243</FONT>         * &lt;p&gt;<a name="line.243"></a>
<FONT color="green">244</FONT>         * For any given application, ideally this set should be "write only" in the sense that once an update is added to the set<a name="line.244"></a>
<FONT color="green">245</FONT>         * and applied to one or more actual databases, the update and its name should thereafter never change. Otherwise,<a name="line.245"></a>
<FONT color="green">246</FONT>         * it would be possible for different databases to have inconsistent schemas even though the same updates were recorded.<a name="line.246"></a>
<FONT color="green">247</FONT>         *<a name="line.247"></a>
<FONT color="green">248</FONT>         * &lt;p&gt;<a name="line.248"></a>
<FONT color="green">249</FONT>         * Furthermore, if not configured to {@link #setIgnoreUnrecognizedUpdates ignore unrecognized updates already applied}<a name="line.249"></a>
<FONT color="green">250</FONT>         * (the default behavior), then updates must never be removed from this set as the application evolves;<a name="line.250"></a>
<FONT color="green">251</FONT>         * see {@link #setIgnoreUnrecognizedUpdates} for more information on the rationale.<a name="line.251"></a>
<FONT color="green">252</FONT>         *<a name="line.252"></a>
<FONT color="green">253</FONT>         * @param updates all schema updates; each update must have a unique {@link SchemaUpdate#getName name}.<a name="line.253"></a>
<FONT color="green">254</FONT>         * @see #getUpdates<a name="line.254"></a>
<FONT color="green">255</FONT>         * @see #setIgnoreUnrecognizedUpdates<a name="line.255"></a>
<FONT color="green">256</FONT>         */<a name="line.256"></a>
<FONT color="green">257</FONT>        public void setUpdates(Collection&lt;SchemaUpdate&gt; updates) {<a name="line.257"></a>
<FONT color="green">258</FONT>            this.updates = updates;<a name="line.258"></a>
<FONT color="green">259</FONT>        }<a name="line.259"></a>
<FONT color="green">260</FONT>    <a name="line.260"></a>
<FONT color="green">261</FONT>        /**<a name="line.261"></a>
<FONT color="green">262</FONT>         * Determine whether unrecognized updates are ignored or cause an exception.<a name="line.262"></a>
<FONT color="green">263</FONT>         *<a name="line.263"></a>
<FONT color="green">264</FONT>         * @return true if unrecognized updates should be ignored, false if they should cause an exception to be thrown<a name="line.264"></a>
<FONT color="green">265</FONT>         * @see #setIgnoreUnrecognizedUpdates setIgnoreUnrecognizedUpdates()<a name="line.265"></a>
<FONT color="green">266</FONT>         */<a name="line.266"></a>
<FONT color="green">267</FONT>        public boolean isIgnoreUnrecognizedUpdates() {<a name="line.267"></a>
<FONT color="green">268</FONT>            return this.ignoreUnrecognizedUpdates;<a name="line.268"></a>
<FONT color="green">269</FONT>        }<a name="line.269"></a>
<FONT color="green">270</FONT>    <a name="line.270"></a>
<FONT color="green">271</FONT>        /**<a name="line.271"></a>
<FONT color="green">272</FONT>         * Configure behavior when an unknown update is registered as having already been applied in the database.<a name="line.272"></a>
<FONT color="green">273</FONT>         *<a name="line.273"></a>
<FONT color="green">274</FONT>         * &lt;p&gt;<a name="line.274"></a>
<FONT color="green">275</FONT>         * The default behavior is &lt;code&gt;false&lt;/code&gt;, which results in an exception being thrown. This protects against<a name="line.275"></a>
<FONT color="green">276</FONT>         * accidental downgrades (i.e., running older code against a database with a newer schema), which are not supported.<a name="line.276"></a>
<FONT color="green">277</FONT>         * However, this also requires that all updates that might ever possibly have been applied to the database be<a name="line.277"></a>
<FONT color="green">278</FONT>         * present in the set of configured updates.<a name="line.278"></a>
<FONT color="green">279</FONT>         *<a name="line.279"></a>
<FONT color="green">280</FONT>         * &lt;p&gt;<a name="line.280"></a>
<FONT color="green">281</FONT>         * Setting this to &lt;code&gt;true&lt;/code&gt; will result in unrecognized updates simply being ignored.<a name="line.281"></a>
<FONT color="green">282</FONT>         * This setting loses the downgrade protection but allows obsolete schema updates to be dropped over time.<a name="line.282"></a>
<FONT color="green">283</FONT>         *<a name="line.283"></a>
<FONT color="green">284</FONT>         * @param ignoreUnrecognizedUpdates whether to ignore unrecognized updates<a name="line.284"></a>
<FONT color="green">285</FONT>         * @see #isIgnoreUnrecognizedUpdates<a name="line.285"></a>
<FONT color="green">286</FONT>         */<a name="line.286"></a>
<FONT color="green">287</FONT>        public void setIgnoreUnrecognizedUpdates(boolean ignoreUnrecognizedUpdates) {<a name="line.287"></a>
<FONT color="green">288</FONT>            this.ignoreUnrecognizedUpdates = ignoreUnrecognizedUpdates;<a name="line.288"></a>
<FONT color="green">289</FONT>        }<a name="line.289"></a>
<FONT color="green">290</FONT>    <a name="line.290"></a>
<FONT color="green">291</FONT>        /**<a name="line.291"></a>
<FONT color="green">292</FONT>         * Perform database schema initialization and updates.<a name="line.292"></a>
<FONT color="green">293</FONT>         *<a name="line.293"></a>
<FONT color="green">294</FONT>         * &lt;p&gt;<a name="line.294"></a>
<FONT color="green">295</FONT>         * This method applies the following logic: if the {@link #databaseNeedsInitialization database needs initialization},<a name="line.295"></a>
<FONT color="green">296</FONT>         * then {@link #initializeDatabase initialize} the database; then, {@link #applySchemaUpdates apply schema updates} as needed.<a name="line.296"></a>
<FONT color="green">297</FONT>         * The database initialization step and each schema update is applied within its own transaction.<a name="line.297"></a>
<FONT color="green">298</FONT>         *<a name="line.298"></a>
<FONT color="green">299</FONT>         * @throws SQLException if an update fails<a name="line.299"></a>
<FONT color="green">300</FONT>         * @throws IllegalStateException if the database needs initialization and either the<a name="line.300"></a>
<FONT color="green">301</FONT>         *  {@link #setDatabaseInitialization database initialization} or<a name="line.301"></a>
<FONT color="green">302</FONT>         *  the {@link #setUpdateTableInitialization update table initialization} has not been configured<a name="line.302"></a>
<FONT color="green">303</FONT>         * @throws IllegalStateException if this instance is not configured to {@link #setIgnoreUnrecognizedUpdates ignore<a name="line.303"></a>
<FONT color="green">304</FONT>         * unrecognized updates} and an unrecognized update is registered in the update table as having already been applied<a name="line.304"></a>
<FONT color="green">305</FONT>         * @throws IllegalArgumentException if two configured updates have the same name<a name="line.305"></a>
<FONT color="green">306</FONT>         * @throws IllegalArgumentException if any configured update has a required predecessor which is not also a configured update<a name="line.306"></a>
<FONT color="green">307</FONT>         *  (i.e., if the updates are not transitively closed under predecessors)<a name="line.307"></a>
<FONT color="green">308</FONT>         */<a name="line.308"></a>
<FONT color="green">309</FONT>        public void initializeAndUpdateDatabase(DataSource dataSource) throws SQLException {<a name="line.309"></a>
<FONT color="green">310</FONT>            log.info("verifying database");<a name="line.310"></a>
<FONT color="green">311</FONT>            if (this.databaseNeedsInitialization(dataSource))<a name="line.311"></a>
<FONT color="green">312</FONT>                this.initializeDatabase(dataSource);<a name="line.312"></a>
<FONT color="green">313</FONT>            this.applySchemaUpdates(dataSource);<a name="line.313"></a>
<FONT color="green">314</FONT>            log.info("database verification complete");<a name="line.314"></a>
<FONT color="green">315</FONT>        }<a name="line.315"></a>
<FONT color="green">316</FONT>    <a name="line.316"></a>
<FONT color="green">317</FONT>        /**<a name="line.317"></a>
<FONT color="green">318</FONT>         * Determine if the database needs initialization.<a name="line.318"></a>
<FONT color="green">319</FONT>         *<a name="line.319"></a>
<FONT color="green">320</FONT>         * &lt;p&gt;<a name="line.320"></a>
<FONT color="green">321</FONT>         * The implementation in {@link SchemaUpdater} simply invokes &lt;code&gt;SELECT COUNT(*) FROM &lt;i&gt;UPDATETABLE&lt;/i&gt;&lt;/code&gt;<a name="line.321"></a>
<FONT color="green">322</FONT>         * and checks for success or failure. Subclasses may wish to override with a more discriminating implementation.<a name="line.322"></a>
<FONT color="green">323</FONT>         * This implementation does not distguish {@link SQLException}s caused by a missing update table from other causes.<a name="line.323"></a>
<FONT color="green">324</FONT>         */<a name="line.324"></a>
<FONT color="green">325</FONT>        public boolean databaseNeedsInitialization(DataSource dataSource) throws SQLException {<a name="line.325"></a>
<FONT color="green">326</FONT>            Connection c = dataSource.getConnection();<a name="line.326"></a>
<FONT color="green">327</FONT>            try {<a name="line.327"></a>
<FONT color="green">328</FONT>                Statement s = c.createStatement();<a name="line.328"></a>
<FONT color="green">329</FONT>                try {<a name="line.329"></a>
<FONT color="green">330</FONT>                    ResultSet resultSet = s.executeQuery("SELECT COUNT(*) FROM " + this.getUpdateTableName());<a name="line.330"></a>
<FONT color="green">331</FONT>                    long numUpdates = resultSet.getLong(1);<a name="line.331"></a>
<FONT color="green">332</FONT>                    log.info("detected already initialized database, with " + numUpdates + " update(s) already applied");<a name="line.332"></a>
<FONT color="green">333</FONT>                    return false;<a name="line.333"></a>
<FONT color="green">334</FONT>                } finally {<a name="line.334"></a>
<FONT color="green">335</FONT>                    s.close();<a name="line.335"></a>
<FONT color="green">336</FONT>                }<a name="line.336"></a>
<FONT color="green">337</FONT>            } catch (SQLException e) {<a name="line.337"></a>
<FONT color="green">338</FONT>                log.warn("detected uninitialized database: update table `" + this.getUpdateTableName() + "' not found: " + e);<a name="line.338"></a>
<FONT color="green">339</FONT>                return true;<a name="line.339"></a>
<FONT color="green">340</FONT>            } finally {<a name="line.340"></a>
<FONT color="green">341</FONT>                c.close();<a name="line.341"></a>
<FONT color="green">342</FONT>            }<a name="line.342"></a>
<FONT color="green">343</FONT>        }<a name="line.343"></a>
<FONT color="green">344</FONT>    <a name="line.344"></a>
<FONT color="green">345</FONT>        /**<a name="line.345"></a>
<FONT color="green">346</FONT>         * Apply a {@link DatabaseAction} to a {@link DataSource}.<a name="line.346"></a>
<FONT color="green">347</FONT>         *<a name="line.347"></a>
<FONT color="green">348</FONT>         * &lt;p&gt;<a name="line.348"></a>
<FONT color="green">349</FONT>         * The implementation in {@link SchemaUpdater} invokes {@link ActionUtils#applyAction}.<a name="line.349"></a>
<FONT color="green">350</FONT>         */<a name="line.350"></a>
<FONT color="green">351</FONT>        protected void applyAction(DataSource dataSource, DatabaseAction action) throws SQLException {<a name="line.351"></a>
<FONT color="green">352</FONT>            ActionUtils.applyAction(dataSource, action);<a name="line.352"></a>
<FONT color="green">353</FONT>        }<a name="line.353"></a>
<FONT color="green">354</FONT>    <a name="line.354"></a>
<FONT color="green">355</FONT>        /**<a name="line.355"></a>
<FONT color="green">356</FONT>         * Apply a {@link DatabaseAction} to a {@link DataSource} within a transaction.<a name="line.356"></a>
<FONT color="green">357</FONT>         *<a name="line.357"></a>
<FONT color="green">358</FONT>         * &lt;p&gt;<a name="line.358"></a>
<FONT color="green">359</FONT>         * The implementation in {@link SchemaUpdater} invokes {@link ActionUtils#applyInTransaction}.<a name="line.359"></a>
<FONT color="green">360</FONT>         */<a name="line.360"></a>
<FONT color="green">361</FONT>        protected void applyInTransaction(DataSource dataSource, DatabaseAction action) throws SQLException {<a name="line.361"></a>
<FONT color="green">362</FONT>            ActionUtils.applyInTransaction(dataSource, action);<a name="line.362"></a>
<FONT color="green">363</FONT>        }<a name="line.363"></a>
<FONT color="green">364</FONT>    <a name="line.364"></a>
<FONT color="green">365</FONT>        /**<a name="line.365"></a>
<FONT color="green">366</FONT>         * Record an update as having been applied.<a name="line.366"></a>
<FONT color="green">367</FONT>         *<a name="line.367"></a>
<FONT color="green">368</FONT>         * &lt;p&gt;<a name="line.368"></a>
<FONT color="green">369</FONT>         * The implementation in {@link SchemaUpdater} does the standard JDBC thing using an INSERT statement<a name="line.369"></a>
<FONT color="green">370</FONT>         * into the update table.<a name="line.370"></a>
<FONT color="green">371</FONT>         */<a name="line.371"></a>
<FONT color="green">372</FONT>        protected void recordUpdateApplied(Connection c, SchemaUpdate update) throws SQLException {<a name="line.372"></a>
<FONT color="green">373</FONT>            PreparedStatement s = c.prepareStatement("INSERT INTO " + this.getUpdateTableName()<a name="line.373"></a>
<FONT color="green">374</FONT>              + " (" + this.getUpdateTableNameColumn() + ", " + this.getUpdateTableTimeColumn() + ") VALUES (?, ?)");<a name="line.374"></a>
<FONT color="green">375</FONT>            try {<a name="line.375"></a>
<FONT color="green">376</FONT>                s.setString(1, update.getName());<a name="line.376"></a>
<FONT color="green">377</FONT>                s.setDate(2, new java.sql.Date(new Date().getTime()));<a name="line.377"></a>
<FONT color="green">378</FONT>                int rows = s.executeUpdate();<a name="line.378"></a>
<FONT color="green">379</FONT>                if (rows != 1) {<a name="line.379"></a>
<FONT color="green">380</FONT>                    throw new IllegalStateException("expected 1 row returned from INSERT but got zero for update `"<a name="line.380"></a>
<FONT color="green">381</FONT>                      + update.getName() + "'");<a name="line.381"></a>
<FONT color="green">382</FONT>                }<a name="line.382"></a>
<FONT color="green">383</FONT>            } finally {<a name="line.383"></a>
<FONT color="green">384</FONT>                s.close();<a name="line.384"></a>
<FONT color="green">385</FONT>            }<a name="line.385"></a>
<FONT color="green">386</FONT>        }<a name="line.386"></a>
<FONT color="green">387</FONT>    <a name="line.387"></a>
<FONT color="green">388</FONT>        /**<a name="line.388"></a>
<FONT color="green">389</FONT>         * Determine which updates have already been applied.<a name="line.389"></a>
<FONT color="green">390</FONT>         *<a name="line.390"></a>
<FONT color="green">391</FONT>         * &lt;p&gt;<a name="line.391"></a>
<FONT color="green">392</FONT>         * The implementation in {@link SchemaUpdater} does the standard JDBC thing using a SELECT statement<a name="line.392"></a>
<FONT color="green">393</FONT>         * from the update table.<a name="line.393"></a>
<FONT color="green">394</FONT>         */<a name="line.394"></a>
<FONT color="green">395</FONT>        protected HashSet&lt;String&gt; getAppliedUpdateNames(Connection c) throws SQLException {<a name="line.395"></a>
<FONT color="green">396</FONT>            Statement s = c.createStatement();<a name="line.396"></a>
<FONT color="green">397</FONT>            try {<a name="line.397"></a>
<FONT color="green">398</FONT>                HashSet&lt;String&gt; updateNames = new HashSet&lt;String&gt;();<a name="line.398"></a>
<FONT color="green">399</FONT>                ResultSet resultSet = s.executeQuery("SELECT " + this.getUpdateTableNameColumn()<a name="line.399"></a>
<FONT color="green">400</FONT>                  + " FROM " + this.getUpdateTableName());<a name="line.400"></a>
<FONT color="green">401</FONT>                while (resultSet.next())<a name="line.401"></a>
<FONT color="green">402</FONT>                    updateNames.add(resultSet.getString(1));<a name="line.402"></a>
<FONT color="green">403</FONT>                return updateNames;<a name="line.403"></a>
<FONT color="green">404</FONT>            } finally {<a name="line.404"></a>
<FONT color="green">405</FONT>                s.close();<a name="line.405"></a>
<FONT color="green">406</FONT>            }<a name="line.406"></a>
<FONT color="green">407</FONT>        }<a name="line.407"></a>
<FONT color="green">408</FONT>    <a name="line.408"></a>
<FONT color="green">409</FONT>        /**<a name="line.409"></a>
<FONT color="green">410</FONT>         * Get the preferred ordering of two updates that do not have any predecessor constraints<a name="line.410"></a>
<FONT color="green">411</FONT>         * (including implied indirect constraints) between them.<a name="line.411"></a>
<FONT color="green">412</FONT>         *<a name="line.412"></a>
<FONT color="green">413</FONT>         * &lt;p&gt;<a name="line.413"></a>
<FONT color="green">414</FONT>         * The {@link Comparator} returned by the implementation in {@link SchemaUpdater} simply sorts updates by name.<a name="line.414"></a>
<FONT color="green">415</FONT>         */<a name="line.415"></a>
<FONT color="green">416</FONT>        protected Comparator&lt;SchemaUpdate&gt; getOrderingTieBreaker() {<a name="line.416"></a>
<FONT color="green">417</FONT>            return new Comparator&lt;SchemaUpdate&gt;() {<a name="line.417"></a>
<FONT color="green">418</FONT>                @Override<a name="line.418"></a>
<FONT color="green">419</FONT>                public int compare(SchemaUpdate update1, SchemaUpdate update2) {<a name="line.419"></a>
<FONT color="green">420</FONT>                    return update1.getName().compareTo(update2.getName());<a name="line.420"></a>
<FONT color="green">421</FONT>                }<a name="line.421"></a>
<FONT color="green">422</FONT>            };<a name="line.422"></a>
<FONT color="green">423</FONT>        }<a name="line.423"></a>
<FONT color="green">424</FONT>    <a name="line.424"></a>
<FONT color="green">425</FONT>        // Initialize the database<a name="line.425"></a>
<FONT color="green">426</FONT>        private void initializeDatabase(final DataSource dataSource) throws SQLException {<a name="line.426"></a>
<FONT color="green">427</FONT>    <a name="line.427"></a>
<FONT color="green">428</FONT>            // Sanity check<a name="line.428"></a>
<FONT color="green">429</FONT>            if (this.getDatabaseInitialization() == null)<a name="line.429"></a>
<FONT color="green">430</FONT>                throw new IllegalArgumentException("database needs initialization but no database initialization is configured");<a name="line.430"></a>
<FONT color="green">431</FONT>            if (this.getUpdateTableInitialization() == null)<a name="line.431"></a>
<FONT color="green">432</FONT>                throw new IllegalArgumentException("database needs initialization but no update table initialization is configured");<a name="line.432"></a>
<FONT color="green">433</FONT>    <a name="line.433"></a>
<FONT color="green">434</FONT>            // Initialize schema within a transaction<a name="line.434"></a>
<FONT color="green">435</FONT>            this.applyInTransaction(dataSource, new DatabaseAction() {<a name="line.435"></a>
<FONT color="green">436</FONT>    <a name="line.436"></a>
<FONT color="green">437</FONT>                @Override<a name="line.437"></a>
<FONT color="green">438</FONT>                public void apply(Connection c) throws SQLException {<a name="line.438"></a>
<FONT color="green">439</FONT>    <a name="line.439"></a>
<FONT color="green">440</FONT>                    // Initialize application schema<a name="line.440"></a>
<FONT color="green">441</FONT>                    SchemaUpdater.this.log.info("intializing database schema");<a name="line.441"></a>
<FONT color="green">442</FONT>                    SchemaUpdater.this.applyAction(dataSource, SchemaUpdater.this.getDatabaseInitialization());<a name="line.442"></a>
<FONT color="green">443</FONT>    <a name="line.443"></a>
<FONT color="green">444</FONT>                    // Initialize update table<a name="line.444"></a>
<FONT color="green">445</FONT>                    SchemaUpdater.this.log.info("intializing update table");<a name="line.445"></a>
<FONT color="green">446</FONT>                    SchemaUpdater.this.applyAction(dataSource, SchemaUpdater.this.getUpdateTableInitialization());<a name="line.446"></a>
<FONT color="green">447</FONT>    <a name="line.447"></a>
<FONT color="green">448</FONT>                    // Record all schema updates as having already been applied<a name="line.448"></a>
<FONT color="green">449</FONT>                    for (SchemaUpdate update : SchemaUpdater.this.getUpdates())<a name="line.449"></a>
<FONT color="green">450</FONT>                        SchemaUpdater.this.recordUpdateApplied(c, update);<a name="line.450"></a>
<FONT color="green">451</FONT>                }<a name="line.451"></a>
<FONT color="green">452</FONT>            });<a name="line.452"></a>
<FONT color="green">453</FONT>        }<a name="line.453"></a>
<FONT color="green">454</FONT>    <a name="line.454"></a>
<FONT color="green">455</FONT>        // Apply schema updates<a name="line.455"></a>
<FONT color="green">456</FONT>        private void applySchemaUpdates(DataSource dataSource) throws SQLException {<a name="line.456"></a>
<FONT color="green">457</FONT>    <a name="line.457"></a>
<FONT color="green">458</FONT>            // Sanity check<a name="line.458"></a>
<FONT color="green">459</FONT>            if (this.getUpdates() == null)<a name="line.459"></a>
<FONT color="green">460</FONT>                throw new IllegalArgumentException("schema updates set is not configured");<a name="line.460"></a>
<FONT color="green">461</FONT>    <a name="line.461"></a>
<FONT color="green">462</FONT>            // Create map of updates by name<a name="line.462"></a>
<FONT color="green">463</FONT>            HashMap&lt;String, SchemaUpdate&gt; updateMap = new HashMap&lt;String, SchemaUpdate&gt;(this.getUpdates().size());<a name="line.463"></a>
<FONT color="green">464</FONT>            for (SchemaUpdate update : this.getUpdates()) {<a name="line.464"></a>
<FONT color="green">465</FONT>                if (updateMap.put(update.getName(), update) != null)<a name="line.465"></a>
<FONT color="green">466</FONT>                    throw new IllegalArgumentException("duplicate schema update name `" + update.getName() + "'");<a name="line.466"></a>
<FONT color="green">467</FONT>            }<a name="line.467"></a>
<FONT color="green">468</FONT>            this.log.debug("these are all known schema updates: " + updateMap.keySet());<a name="line.468"></a>
<FONT color="green">469</FONT>    <a name="line.469"></a>
<FONT color="green">470</FONT>            // Verify updates are transitively closed under predecessor constraints<a name="line.470"></a>
<FONT color="green">471</FONT>            for (SchemaUpdate update : this.getUpdates()) {<a name="line.471"></a>
<FONT color="green">472</FONT>                for (SchemaUpdate predecessor : update.getRequiredPredecessors()) {<a name="line.472"></a>
<FONT color="green">473</FONT>                    if (!this.getUpdates().contains(predecessor)) {<a name="line.473"></a>
<FONT color="green">474</FONT>                        throw new IllegalArgumentException("schema update `" + update.getName()<a name="line.474"></a>
<FONT color="green">475</FONT>                          + "' has a required predecessor `" + predecessor.getName() + "' that is not a configured update");<a name="line.475"></a>
<FONT color="green">476</FONT>                    }<a name="line.476"></a>
<FONT color="green">477</FONT>                }<a name="line.477"></a>
<FONT color="green">478</FONT>            }<a name="line.478"></a>
<FONT color="green">479</FONT>    <a name="line.479"></a>
<FONT color="green">480</FONT>            // Sort updates in the order we should to apply them<a name="line.480"></a>
<FONT color="green">481</FONT>            List&lt;SchemaUpdate&gt; updateList = new TopologicalSorter&lt;SchemaUpdate&gt;(<a name="line.481"></a>
<FONT color="green">482</FONT>              updateMap.values(), new SchemaUpdateEdgeLister(), this.getOrderingTieBreaker()).sortEdgesReversed();<a name="line.482"></a>
<FONT color="green">483</FONT>    <a name="line.483"></a>
<FONT color="green">484</FONT>            // Determine which updates have already been applied<a name="line.484"></a>
<FONT color="green">485</FONT>            Set&lt;String&gt; appliedUpdates;<a name="line.485"></a>
<FONT color="green">486</FONT>            Connection c = dataSource.getConnection();<a name="line.486"></a>
<FONT color="green">487</FONT>            try {<a name="line.487"></a>
<FONT color="green">488</FONT>                appliedUpdates = this.getAppliedUpdateNames(c);<a name="line.488"></a>
<FONT color="green">489</FONT>            } finally {<a name="line.489"></a>
<FONT color="green">490</FONT>                c.close();<a name="line.490"></a>
<FONT color="green">491</FONT>            }<a name="line.491"></a>
<FONT color="green">492</FONT>            this.log.debug("these are the already-applied schema updates: " + appliedUpdates);<a name="line.492"></a>
<FONT color="green">493</FONT>    <a name="line.493"></a>
<FONT color="green">494</FONT>            // Check whether any unknown updates have been applied; remove already-applied updates from our update map<a name="line.494"></a>
<FONT color="green">495</FONT>            HashSet&lt;String&gt; unknown = new HashSet&lt;String&gt;();<a name="line.495"></a>
<FONT color="green">496</FONT>            for (String updateName : appliedUpdates) {<a name="line.496"></a>
<FONT color="green">497</FONT>                if (!updateMap.containsKey(updateName))<a name="line.497"></a>
<FONT color="green">498</FONT>                    unknown.add(updateName);<a name="line.498"></a>
<FONT color="green">499</FONT>            }<a name="line.499"></a>
<FONT color="green">500</FONT>            if (!unknown.isEmpty()) {<a name="line.500"></a>
<FONT color="green">501</FONT>                if (!this.isIgnoreUnrecognizedUpdates())<a name="line.501"></a>
<FONT color="green">502</FONT>                    throw new IllegalStateException(unknown.size() + " unrecognized update(s) have already been applied: " + unknown);<a name="line.502"></a>
<FONT color="green">503</FONT>                this.log.info("ignoring " + unknown.size() + " unrecognized update(s) already applied: " + unknown);<a name="line.503"></a>
<FONT color="green">504</FONT>            }<a name="line.504"></a>
<FONT color="green">505</FONT>    <a name="line.505"></a>
<FONT color="green">506</FONT>            // Elide the already-applied updates from the list<a name="line.506"></a>
<FONT color="green">507</FONT>            List&lt;String&gt; updateNames = new ArrayList&lt;String&gt;(updateList.size());<a name="line.507"></a>
<FONT color="green">508</FONT>            ArrayList&lt;SchemaUpdate&gt; trimmedList = new ArrayList&lt;SchemaUpdate&gt;(updateList.size());<a name="line.508"></a>
<FONT color="green">509</FONT>            for (SchemaUpdate update : updateList) {<a name="line.509"></a>
<FONT color="green">510</FONT>                if (!appliedUpdates.contains(update.getName())) {<a name="line.510"></a>
<FONT color="green">511</FONT>                    trimmedList.add(update);<a name="line.511"></a>
<FONT color="green">512</FONT>                    updateNames.add(update.getName());<a name="line.512"></a>
<FONT color="green">513</FONT>                }<a name="line.513"></a>
<FONT color="green">514</FONT>            }<a name="line.514"></a>
<FONT color="green">515</FONT>            updateList = trimmedList;<a name="line.515"></a>
<FONT color="green">516</FONT>    <a name="line.516"></a>
<FONT color="green">517</FONT>            // Now any updates needed?<a name="line.517"></a>
<FONT color="green">518</FONT>            if (updateList.isEmpty()) {<a name="line.518"></a>
<FONT color="green">519</FONT>                this.log.info("no schema updates are required");<a name="line.519"></a>
<FONT color="green">520</FONT>                return;<a name="line.520"></a>
<FONT color="green">521</FONT>            }<a name="line.521"></a>
<FONT color="green">522</FONT>    <a name="line.522"></a>
<FONT color="green">523</FONT>            // Apply updates<a name="line.523"></a>
<FONT color="green">524</FONT>            this.log.info("applying these " + updateNames.size() + " schema update(s): " + updateNames);<a name="line.524"></a>
<FONT color="green">525</FONT>            for (SchemaUpdate update0 : updateList) {<a name="line.525"></a>
<FONT color="green">526</FONT>                final SchemaUpdate update = update0;<a name="line.526"></a>
<FONT color="green">527</FONT>                this.applyInTransaction(dataSource, new DatabaseAction() {<a name="line.527"></a>
<FONT color="green">528</FONT>    <a name="line.528"></a>
<FONT color="green">529</FONT>                    @Override<a name="line.529"></a>
<FONT color="green">530</FONT>                    public void apply(Connection c) throws SQLException {<a name="line.530"></a>
<FONT color="green">531</FONT>                        SchemaUpdater.this.log.info("applying schema update `" + update.getName() + "'");<a name="line.531"></a>
<FONT color="green">532</FONT>                        update.apply(c);<a name="line.532"></a>
<FONT color="green">533</FONT>                        SchemaUpdater.this.recordUpdateApplied(c, update);<a name="line.533"></a>
<FONT color="green">534</FONT>                    }<a name="line.534"></a>
<FONT color="green">535</FONT>                });<a name="line.535"></a>
<FONT color="green">536</FONT>            }<a name="line.536"></a>
<FONT color="green">537</FONT>        }<a name="line.537"></a>
<FONT color="green">538</FONT>    }<a name="line.538"></a>
<FONT color="green">539</FONT>    <a name="line.539"></a>




























































</PRE>
</BODY>
</HTML>
